Remove memory store and increase test coverage #1011

MHassanTariq · 2022-01-31T12:20:45Z

Description

This PR increases the test coverage. It adds test cases that were previously not catered.

For details refer to issue #985

Checklist

Code is commented where needed
Unit test coverage for new or modified code paths
npm run test passes
Changelog is updated
Tag 1 of @rafaelcr or @zone117x for review

github-actions · 2022-01-31T12:22:42Z

🚀 Deployed on https://deploy-preview-1011--stacks-blockchain-api.netlify.app

codecov-commenter · 2022-01-31T12:23:14Z

Codecov Report

Merging #1011 (48c8e05) into develop (6fe829c) will increase coverage by 2.62%.
The diff coverage is 0.00%.

@@             Coverage Diff             @@
##           develop    #1011      +/-   ##
===========================================
+ Coverage    72.96%   75.59%   +2.62%     
===========================================
  Files           91       90       -1     
  Lines         9900     9563     -337     
  Branches      1928     1897      -31     
===========================================
+ Hits          7224     7229       +5     
+ Misses        2561     2230     -331     
+ Partials       115      104      -11

Impacted Files	Coverage Δ
src/index.ts	`0.00% <0.00%> (ø)`
src/rosetta-helpers.ts	`72.38% <0.00%> (+0.39%)`	⬆️
src/api/controllers/db-controller.ts	`79.12% <0.00%> (+0.72%)`	⬆️
src/datastore/postgres-store.ts	`87.63% <0.00%> (+0.76%)`	⬆️
src/api/routes/tx.ts	`78.33% <0.00%> (+1.11%)`	⬆️
src/api/routes/block.ts	`90.41% <0.00%> (+15.06%)`	⬆️
src/api/routes/status.ts	`72.72% <0.00%> (+22.72%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6fe829c...48c8e05. Read the comment docs.

MHassanTariq · 2022-02-22T11:19:03Z

This PR is complete for now. I will make a new PR for rosetta test cases to increase the code coverage.

MHassanTariq · 2022-02-22T12:55:39Z

@rafaelcr I was trying to rebase this PR. However, one of my tests, here, that I added in this PR has been failing. The error shown is

TypeError: Cannot read properties of undefined (reading 'count')

This error is generated as the length of rows for total is 0.
Can you suggest anything on how to resolve this?

rafaelcr · 2022-03-23T00:22:52Z

src/datastore/postgres-store.ts

@@ -2985,6 +2986,7 @@ export class PgDataStore
        `,
        [limit, offset]
      );
+      console.log('printing results here: ', results);


Could you remove these debug logs?

rafaelcr · 2022-03-23T00:24:33Z

src/index.ts

@@ -141,11 +140,6 @@ async function init(): Promise<void> {
    db = OfflineDummyStore;
  } else {
    switch (process.env['STACKS_BLOCKCHAIN_API_DB']) {


This env variable is now unused. Can you remove it from the entire project?

rafaelcr · 2022-03-23T00:29:04Z

src/tests/setup.ts

@@ -12,9 +12,11 @@ export default async (): Promise<void> => {
    process.env.NODE_ENV = 'test';
  }
  loadDotEnv();
+  process.env.PG_DATABASE = 'postgres';
+  const db = await PgDataStore.connect({ skipMigrations: true, usageName: 'setup' });
  const server = await startEventServer({


If I'm not mistaken, this entire global server is never used... Can you try removing it (also removing the db) from here and teardown.ts to see if tests are at all affected? If not, we should delete it.

rafaelcr · 2022-03-24T13:30:10Z

src/datastore/postgres-store.ts

@@ -2974,6 +2974,7 @@ export class PgDataStore
      const total = await client.query<{ count: number }>(`
        SELECT block_count AS count FROM chain_tip
      `);
+      console.log('printing total rows here: ', total.rows);


Remove this one too

rafaelcr · 2022-03-24T14:01:39Z

src/tests-bns/setup.ts

-  if (!process.env.NODE_ENV) {
-    process.env.NODE_ENV = 'test';
-  }


These lines should be kept

rafaelcr · 2022-03-24T14:02:06Z

src/tests-rosetta/setup.ts

-  if (!process.env.NODE_ENV) {
-    process.env.NODE_ENV = 'test';
-  }


Keep these lines too

rafaelcr · 2022-03-24T14:03:07Z

src/tests-tokens/setup.ts

-  if (!process.env.NODE_ENV) {
-    process.env.NODE_ENV = 'test';
-  }


rafaelcr · 2022-03-24T14:05:07Z

utils/src/index.ts

@@ -27,7 +27,7 @@ type TableCellValue = string | number | bigint | undefined;
 * @param blockHeight Specific block height at which to query balances
 */
 async function printTopAccountBalances(count: number, blockHeight: number) {
-  const db = await PgDataStore.connect(true);
+  const db = await PgDataStore.connect({ skipMigrations: true, usageName: 'tests' });


Suggested change

const db = await PgDataStore.connect({ skipMigrations: true, usageName: 'tests' });

const db = await PgDataStore.connect({ skipMigrations: true, usageName: 'utils' });

rafaelcr

LGTM 👍
Before merging, can you change the PR's title to "Remove memory store and increase test coverage"?

blockstack-devops · 2022-04-20T20:07:27Z

🎉 This PR is included in version 4.0.0-beta.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

blockstack-devops · 2022-05-26T15:49:16Z

🎉 This PR is included in version 4.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

MHassanTariq changed the base branch from master to develop January 31, 2022 12:20

github-actions bot temporarily deployed to pull request January 31, 2022 12:22 Inactive

MHassanTariq linked an issue Feb 7, 2022 that may be closed by this pull request

Increase test code coverage to 80% #985

Open

github-actions bot temporarily deployed to pull request February 7, 2022 12:26 Inactive

github-actions bot temporarily deployed to commit February 7, 2022 12:26 Inactive

MHassanTariq self-assigned this Feb 8, 2022

github-actions bot temporarily deployed to commit February 15, 2022 15:25 Inactive

MHassanTariq changed the title ~~[Draft] Increase test coverage~~ Increase test coverage Feb 17, 2022

MHassanTariq marked this pull request as ready for review February 17, 2022 08:34

MHassanTariq requested review from zone117x, asimm241 and rafaelcr February 22, 2022 11:18

MHassanTariq force-pushed the increase_test_coverage branch from 9d7518a to b1deb6d Compare February 24, 2022 12:43

github-actions bot temporarily deployed to pull request February 24, 2022 12:45 Inactive

github-actions bot temporarily deployed to commit February 24, 2022 12:45 Inactive

rafaelcr requested changes Mar 23, 2022

View reviewed changes

github-actions bot temporarily deployed to pull request March 24, 2022 11:34 Inactive

github-actions bot temporarily deployed to commit March 24, 2022 11:34 Inactive

rafaelcr requested changes Mar 24, 2022

View reviewed changes

rafaelcr approved these changes Mar 30, 2022

View reviewed changes

MHassanTariq added 6 commits March 31, 2022 14:11

test: added block and status tests

5c19c3c

test: added rosetta tests

f9842d5

refactor: removed memory-store.ts

c6dbf34

fix: test failing to exit

53efbf8

fix: failing error in api-tests.ts

906774a

fix: fixed api-tests.ts

e8e0d3e

MHassanTariq added 3 commits March 31, 2022 14:13

refactor: removed unecessory comments

490e91d

refactor: removed unecessary global server

f5854b7

revert: unnecessary changes

48c8e05

MHassanTariq force-pushed the increase_test_coverage branch from 8d3994f to 48c8e05 Compare March 31, 2022 09:22

MHassanTariq changed the title ~~Increase test coverage~~ Remove memory store and increase test coverage Mar 31, 2022

github-actions bot temporarily deployed to commit March 31, 2022 09:25 Inactive

github-actions bot temporarily deployed to pull request March 31, 2022 09:25 Inactive

MHassanTariq requested a review from rafaelcr March 31, 2022 09:49

rafaelcr approved these changes Mar 31, 2022

View reviewed changes

rafaelcr merged commit cacf9a6 into develop Mar 31, 2022

rafaelcr deleted the increase_test_coverage branch March 31, 2022 17:27

MHassanTariq mentioned this pull request Apr 8, 2022

Increase Rosetta Test Coverage #1141

Merged

9 tasks

blockstack-devops added the released on @beta label Apr 20, 2022

blockstack-devops added the released label May 26, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove memory store and increase test coverage #1011

Remove memory store and increase test coverage #1011

MHassanTariq commented Jan 31, 2022

github-actions bot commented Jan 31, 2022 •

edited

Loading

codecov-commenter commented Jan 31, 2022 •

edited

Loading

MHassanTariq commented Feb 22, 2022

MHassanTariq commented Feb 22, 2022 •

edited

Loading

rafaelcr Mar 23, 2022

rafaelcr Mar 23, 2022

rafaelcr Mar 23, 2022

rafaelcr Mar 24, 2022

rafaelcr Mar 24, 2022

rafaelcr Mar 24, 2022

rafaelcr Mar 24, 2022

rafaelcr Mar 24, 2022

rafaelcr left a comment

blockstack-devops commented Apr 20, 2022

blockstack-devops commented May 26, 2022

	const db = await PgDataStore.connect({ skipMigrations: true, usageName: 'tests' });
	const db = await PgDataStore.connect({ skipMigrations: true, usageName: 'utils' });

Remove memory store and increase test coverage #1011

Remove memory store and increase test coverage #1011

Conversation

MHassanTariq commented Jan 31, 2022

Description

Checklist

github-actions bot commented Jan 31, 2022 • edited Loading

codecov-commenter commented Jan 31, 2022 • edited Loading

Codecov Report

MHassanTariq commented Feb 22, 2022

MHassanTariq commented Feb 22, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rafaelcr left a comment

Choose a reason for hiding this comment

blockstack-devops commented Apr 20, 2022

blockstack-devops commented May 26, 2022

github-actions bot commented Jan 31, 2022 •

edited

Loading

codecov-commenter commented Jan 31, 2022 •

edited

Loading

MHassanTariq commented Feb 22, 2022 •

edited

Loading