Feat/streams api #658

sogunshola · 2022-09-08T07:52:17Z

name: 'Pull request'
about: A new pull request

New Pull Request

Checklist

I am not disclosing a vulnerability.
My code is conform the code style
I have made corresponding changes to the documentation
I have updated Typescript definitions when needed

Issue Description

Related issue: #FILL_THIS_OUT

Solution Description

add package that integrates stream API

…into feat/streams-api

changeset-bot · 2022-09-08T07:52:20Z

🦋 Changeset detected

Latest commit: 28ee0da

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 9 packages

Name	Type
@moralisweb3/api-utils	Minor
@moralisweb3/core	Minor
moralis	Minor
@moralisweb3/streams	Minor
@moralisweb3/auth	Minor
@moralisweb3/evm-utils	Minor
@moralisweb3/sol-utils	Minor
@moralisweb3/evm-api	Minor
@moralisweb3/sol-api	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

b4rtaz · 2022-09-08T07:55:17Z

packages/streams/src/MoralisStreams.ts

+  public add = this.endpoints.createFetcher(createStream);
+
+  public update = this.endpoints.createFetcher(updateStream);
+
+  public getAll = this.endpoints.createPaginatedFetcher(getStreams);
+
+  public delete = this.endpoints.createFetcher(deleteStream);
+
+  public setSettings = this.endpoints.createFetcher(setSettings);
+
+  private _readSettings = this.endpoints.createFetcher(readSettings);


readonly attribute is missing.

b4rtaz · 2022-09-08T07:59:13Z

packages/integration/mockRequests/streamApi/createStream.ts

+  const apiKey = req.headers.get('x-api-key');
+
+  if (apiKey !== MOCK_API_KEY) {
+    return res(ctx.status(401));
+  }
+
+  const value = mockCreateStreamOutput;
+
+  if (!value) {
+    return res(ctx.status(404));
+  }
+
+  return res(ctx.status(200), ctx.json(value));


We should create mocks based on a real API response. Check this file:

getBlock.ts

getNFTOwners.ts

That allows us to create better integration tests:

getBlock.test.ts

getNFTOwners.test.ts

b4rtaz · 2022-09-08T08:00:23Z

packages/integration/mockRequests/streamApi/deleteStream.ts

+  const id = req.params.id as string;
+  const apiKey = req.headers.get('x-api-key');
+
+  if (apiKey !== MOCK_API_KEY) {
+    return res(ctx.status(401));
+  }
+
+  const value = mockDeleteStreamOutput[id];
+
+  if (!value) {
+    return res(ctx.status(404));
+  }
+
+  return res(
+    ctx.status(200),
+    ctx.json({
+      chainId: value,
+    }),
+  );


Needs a real response mock.

b4rtaz · 2022-09-08T08:00:30Z

packages/integration/mockRequests/streamApi/getSettings.ts

+  const apiKey = req.headers.get('x-api-key');
+
+  if (apiKey !== MOCK_API_KEY) {
+    return res(ctx.status(401));
+  }
+
+  const value = mockGetSettingsOutput;
+
+  if (!value) {
+    return res(ctx.status(404));
+  }
+
+  return res(ctx.status(200), ctx.json(value));


Needs a real response mock.

{ "secretKey": "top_secret", "region": "us-east-1" }

is a real response for this endpoint

I see.

const value = mockGetSettingsOutput; if (!value) {

This condition is always false.

b4rtaz · 2022-09-08T08:00:36Z

packages/integration/mockRequests/streamApi/getStreams.ts

+  const apiKey = req.headers.get('x-api-key');
+
+  if (apiKey !== MOCK_API_KEY) {
+    return res(ctx.status(401));
+  }
+
+  const value = mockGetStreamsOutput;
+
+  if (!value) {
+    return res(ctx.status(404));
+  }
+
+  return res(
+    ctx.status(200),
+    ctx.json({
+      total: value,
+    }),
+  );


Needs a real response mock.

b4rtaz · 2022-09-08T08:00:41Z

packages/integration/mockRequests/streamApi/setSettings.ts

+  const apiKey = req.headers.get('x-api-key');
+
+  if (apiKey !== MOCK_API_KEY) {
+    return res(ctx.status(401));
+  }
+
+  const value = mockSetSettingsOutput;
+
+  if (!value) {
+    return res(ctx.status(404));
+  }
+
+  return res(ctx.status(200), ctx.json(value));


Needs a real response mock.

b4rtaz · 2022-09-08T08:00:46Z

packages/integration/mockRequests/streamApi/updateStream.ts

+  const id = req.params.id as string;
+  const apiKey = req.headers.get('x-api-key');
+
+  if (apiKey !== MOCK_API_KEY) {
+    return res(ctx.status(401));
+  }
+
+  const value = mockUpdateStreamOutput[id];
+
+  if (!value) {
+    return res(ctx.status(404));
+  }
+
+  return res(
+    ctx.status(200),
+    ctx.json({
+      chainId: value,
+    }),
+  );


Needs a real response mock.

b4rtaz · 2022-09-08T08:03:27Z

packages/apiUtils/src/resolvers/PaginatedEndpoint.ts

@@ -13,6 +13,7 @@ export interface PaginatedResult<ApiResult> {
  page_size: number;
  cursor: string;
  result: ApiResult;
+  data: ApiResult;


Maybe we should request the API squad to normalize this property? Here should be also result as everywhere.

I agree, to have consistency across Moralis Apis. @ErnoW what do you think?

I think this is the best option. Otherwise we should modify the PaginatedEndpoint interface. The current state is wrong. We don't have result and data in the same type as the definition says.

b4rtaz · 2022-09-08T08:04:19Z

packages/moralis/package.json

+    "@moralisweb3/auth": "^2.2.0",
+    "@moralisweb3/core": "^2.2.0",
+    "@moralisweb3/api-utils": "^2.2.0",
+    "@moralisweb3/evm-api": "^2.2.0",
+    "@moralisweb3/evm-utils": "^2.2.0",
+    "@moralisweb3/sol-api": "^2.2.0",
+    "@moralisweb3/sol-utils": "^2.2.0"


This is an unwanted change.

b4rtaz

Still I see unnecessary conditions in tests like:

  const value = mockCreateStreamOutput;

  if (!value) {
    return res(ctx.status(404));
  }

Also, we need to clarify the result/data problem.

sogunshola · 2022-09-08T09:13:45Z

Still I see unnecessary conditions in tests like:
  const value = mockCreateStreamOutput;

  if (!value) {
    return res(ctx.status(404));
  }
Also, we need to clarify the result/data problem.

True. Removing unncessary condiitions now

sogunshola added 2 commits September 8, 2022 08:49

feat: StreamApi

7fffd1e

add package that integrates stream API

Merge branch 'main' of https://github.com/MoralisWeb3/Moralis-JS-SDK …

25d0d7a

…into feat/streams-api

sogunshola requested review from ErnoW and b4rtaz September 8, 2022 07:52

include stream package in json file

27f0d89

b4rtaz requested changes Sep 8, 2022

View reviewed changes

sogunshola added 6 commits September 8, 2022 09:12

force package installation

54ccbf6

add readonly attribute and fix versioning

662ff9a

package version

dbd2aa9

use real responses for test

8ef186c

fix pagination option test

3c487e5

fix lint error

7f99816

sogunshola requested a review from b4rtaz September 8, 2022 09:04

b4rtaz requested changes Sep 8, 2022

View reviewed changes

sogunshola added 3 commits September 8, 2022 10:18

remove unnecessary conditions

c815020

correct tests with params

9eff875

update implementation based on swagger changes

28ee0da

b4rtaz approved these changes Sep 8, 2022

View reviewed changes

sogunshola merged commit 9cc480d into main Sep 8, 2022

sogunshola deleted the feat/streams-api branch September 8, 2022 13:14

This was referenced Sep 8, 2022

Version Packages #661

Merged

Version Packages 3scava1i3r/Moralis-JS-SDK#1

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat/streams api #658

Feat/streams api #658

sogunshola commented Sep 8, 2022

changeset-bot bot commented Sep 8, 2022 •

edited

Loading

b4rtaz Sep 8, 2022

b4rtaz Sep 8, 2022

b4rtaz Sep 8, 2022

b4rtaz Sep 8, 2022

sogunshola Sep 8, 2022

b4rtaz Sep 8, 2022 •

edited

Loading

b4rtaz Sep 8, 2022

b4rtaz Sep 8, 2022

b4rtaz Sep 8, 2022

b4rtaz Sep 8, 2022

sogunshola Sep 8, 2022

b4rtaz Sep 8, 2022

b4rtaz Sep 8, 2022

b4rtaz left a comment

sogunshola commented Sep 8, 2022

Feat/streams api #658

Feat/streams api #658

Conversation

sogunshola commented Sep 8, 2022

name: 'Pull request' about: A new pull request

New Pull Request

Checklist

Issue Description

Solution Description

changeset-bot bot commented Sep 8, 2022 • edited Loading

🦋 Changeset detected

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

b4rtaz Sep 8, 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

b4rtaz left a comment

Choose a reason for hiding this comment

sogunshola commented Sep 8, 2022

name: 'Pull request'
about: A new pull request

changeset-bot bot commented Sep 8, 2022 •

edited

Loading

b4rtaz Sep 8, 2022 •

edited

Loading