jscutlery / convoyr Goto Github PK

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: undefined. Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.

A plugin that re-fetch data by :

• interval
• network reconnection
• window focus after inactivity

Lerna needs dist files in directory relative to the package.
We are currently copying that package manually on prepublish. This is cumbersome and error prone.

Maybe we should configure that dist directory in angular.json (but we have to remember to do that again when we create new libs).

We could also just build the needed package in prepublish script instead of build everything with nx before.

https://netbasal.com/new-in-angular-v12-passing-context-to-http-interceptors-308a1ca2f3dd

Summary

In this RFC we propose adding an HTTP client wrapper for Convoyr.

After some discussions with @yjaaidi we think that Convoyr should benefit from having its own HTTP client. Actually we're facing two major issues with Convoyr :

1. Actual implementation relies on HttpInterceptor which are powerful for handling some global features, like authentication, but is heavily missing a per request plugin mechanism.
2. From the beginning we really want to make Convoyr platform agnostic, @convoyr/core was initially built with this aspect in mind, but here also, the use of interceptors is very limiting for extending the Node.js platform.

Examples

One basic example.

convoyr.get('/service', { plugins: [createCachePlugin()] })

Another example with Angular.

export class BikeSearchComponent {
  searchControl = new FormControl();
  bikes$ = this.searchControl.valueChanges.pipe(
    startWith(''),
    switchMap((query) =>
      this.convoyr.get<{ bikes: Bike[] }>(
        environment.apiBaseUrl + '/bikes',
        {
          params: { q: query },
          plugins: [createCachePlugin()],
        }
      )
    ),
    shareReplay({ bufferSize: 1, refCount: true })
  );

  constructor(private convoyr: Convoyr) {}
}

Detailed design

Some subtle aspects of this design that we especially appreciate :

• Use an underlying client through the adapter pattern,
• isomorphism with Angular HttpClient,
• provide an Axios adapter,
• provide an Angular adapter,
• focus on JSON APIs features.

Execution plan for Angular :

Convoyr.get => Plugin A => Plugin B => Convoyr Angular Adapter => HttpClient.get(...)

For Axios :

Convoyr.get => Plugin A => Plugin B => Convoyr Axios Adapter => Axios.get(...)

NOTE: Suggestions or comments are highly appreciated.

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Repository problems

These problems occurred while renovating this repository. View logs.

• WARN: Found renovate config warnings

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• chore: 📦 replace dependency npm-run-all with npm-run-all2 ^5.0.0
• chore: 📦 update angular-cli monorepo (@angular-devkit/build-angular, @angular/cli)
• chore: 📦 update dependency @types/express to v4.17.21
• chore: 📦 update dependency jest-date-mock to v1.0.10
• fix: 📦 update dependency bytes to v3.1.2
• chore: 📦 update dependency @hirez_io/observer-spy to v2.2.0
• chore: 📦 update dependency @types/node to v16.18.98
• chore: 📦 update dependency all-contributors-cli to v6.26.1
• chore: 📦 update dependency prettier to v2.8.8
• chore: 📦 update dependency tsickle to ^0.46.0
• chore: 📦 update jest monorepo (@types/jest, jest)
• fix: 📦 update dependency body-parser to v1.20.2
• fix: 📦 update dependency core-js to v3.37.1
• fix: 📦 update dependency tslib to v2.6.3
• fix: 📦 update dependency zone.js to ~0.14.0
• chore: 📦 update actions/cache action to v4
• chore: 📦 update actions/checkout action to v4
• chore: 📦 update actions/setup-node action to v4
• chore: 📦 update codecov/codecov-action action to v4
• chore: 📦 update dependency @types/lru-cache to v7
• chore: 📦 update dependency @types/node to v20
• chore: 📦 update dependency cypress to v13
• chore: 📦 update dependency dotenv to v16
• chore: 📦 update dependency eslint to v9
• chore: 📦 update dependency husky to v9
• chore: 📦 update dependency jest-preset-angular to v14
• chore: 📦 update dependency lerna to v8
• chore: 📦 update dependency lint-staged to v15
• chore: 📦 update dependency ng-packagr to v18
• chore: 📦 update dependency prettier to v3
• chore: 📦 update dependency typescript to v5
• chore: 📦 update jest monorepo to v29 (major) (@types/jest, jest, ts-jest)
• fix: 📦 update dependency backoff-rxjs to v7
• fix: 📦 update dependency lru-cache to v10
• chore: 📦 lock file maintenance
• 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore: 📦 update dependency lint-staged to v11.2.6
• chore: 📦 update dependency typescript to ~4.9.0
• chore: 📦 update nrwl monorepo to v11.6.3 (@nrwl/cypress, @nrwl/jest, @nrwl/node, @nrwl/workspace)
• chore: 📦 update angular-cli monorepo to v18 (major) (@angular-devkit/build-angular, @angular/cli)
• chore: 📦 update commitlint monorepo to v19 (major) (@commitlint/cli, @commitlint/config-angular, @commitlint/config-conventional)
• chore: 📦 update dependency ts-node to v10
• fix: 📦 update angular monorepo to v18 (major) (@angular/animations, @angular/common, @angular/compiler, @angular/compiler-cli, @angular/core, @angular/forms, @angular/language-service, @angular/platform-browser, @angular/platform-browser-dynamic, @angular/router)
• fix: 📦 update angularmaterial monorepo to v18 (major) (@angular/cdk, @angular/material)
• fix: 📦 update dependency rxjs to v7
• fix: 📦 update nrwl monorepo to v19 (major) (@nrwl/angular, @nrwl/cypress, @nrwl/express, @nrwl/jest, @nrwl/node, @nrwl/workspace)
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

I just installed this plugin with the settings you defined in the readme in my AppModule. Immediately, a form directive that was using the code below started failing. Upon further inspection, we could see that it would only include the last param we set. The moment we removed convoyr from AppModule, both request params were back on the url.

Example:

@Injectable({providedIn: 'root'})
export class HotelUrlNameService {
  isUrlNameAvailable(hotelIdentifier: string, urlName: string): Observable<UniqueResult> {

    const params = new HttpParams()
    .set('hotelIdentifier', hotelIdentifier)
    .set('urlName', urlName)
    ;

    return this.httpClient.get<UniqueResult>(`${this.environment.inventoryAPIEndpointBaseURL}/api/administration/hotel/urlname`, { params });
  }

  constructor(private readonly httpClient: HttpClient,
              @Inject(ENVIRONMENT) private readonly environment: any) {
  }
}

In the same way Angular exposes url and urlWithParams properties to HttpRequest, we can add a util function to get the same result from urlWithParams to simplify query-string usage in plugins.

See the install guide, the migration guide and this blog post for informations.

A specific cache plugin for ReSTful API, probably based on the current cache plugin could improve caching by understanding the semantics of the API.

Here are some examples:

GET /items => {items: [{id: '123', name: 'demo'}]}
GET /items/123 => cache hit => {id: '123', name: 'demo'}
(PATCH|PUT) /items/123  {name: 'updated demo'} => {id: '123', name: 'updated demo'} => update item in storage using response
GET /items => {items: [{id: '123', name: 'updated demo'}]}