Skip to content

Skip pinning on get claim #688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JGiter wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

Skip pinning on get claim #688

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
592151d
fix: skip pinning on get claim
JGiter May 16, 2025
698a7f1
chore: revert pin job comment
JGiter May 16, 2025
ac2024e
build: add ipfs disabled to argo env
JGiter May 16, 2025
3b86b9e
chore: disable ipfs cluster tests
JGiter May 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions devops/dev/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ iam-cache-server-helm:
TYPEORM_LOGGING: error,warn
TYPEORM_LOGGER: file
DISABLE_GET_DIDS_BY_ROLE: true
IPFS_CLUSTER_PINNING_ENABLED: false

opsValues:
DB_NAME: ics
Expand Down
1 change: 1 addition & 0 deletions devops/prod/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ iam-cache-server-helm:
TYPEORM_LOGGING: error,warn
TYPEORM_LOGGER: file
DISABLE_GET_DIDS_BY_ROLE: true
IPFS_CLUSTER_PINNING_ENABLED: false

opsValues:
DB_NAME: ics
Expand Down
1 change: 1 addition & 0 deletions devops/staging/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ iam-cache-server-helm:
TYPEORM_LOGGING: error,warn
TYPEORM_LOGGER: file
DISABLE_GET_DIDS_BY_ROLE: true
IPFS_CLUSTER_PINNING_ENABLED: false

opsValues:
DB_NAME: ics
Expand Down
223 changes: 0 additions & 223 deletions docs/api/classes/modules_auth_login_strategy.AuthStrategy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,6 @@

- [constructor](modules_auth_login_strategy.AuthStrategy.md#constructor)

### Methods

- [authenticate](modules_auth_login_strategy.AuthStrategy.md#authenticate)
- [decodeToken](modules_auth_login_strategy.AuthStrategy.md#decodetoken)
- [didUnification](modules_auth_login_strategy.AuthStrategy.md#didunification)
- [extractSiwe](modules_auth_login_strategy.AuthStrategy.md#extractsiwe)
- [extractToken](modules_auth_login_strategy.AuthStrategy.md#extracttoken)
- [getRoleDefinition](modules_auth_login_strategy.AuthStrategy.md#getroledefinition)
- [isEIP191TokenPayload](modules_auth_login_strategy.AuthStrategy.md#iseip191tokenpayload)
- [isSiweMessagePayload](modules_auth_login_strategy.AuthStrategy.md#issiwemessagepayload)
- [validate](modules_auth_login_strategy.AuthStrategy.md#validate)
- [verifyIssuer](modules_auth_login_strategy.AuthStrategy.md#verifyissuer)

## Constructors

### constructor
Expand All @@ -46,213 +33,3 @@
#### Overrides

PassportStrategy(LoginStrategy, 'login').constructor

## Methods

### authenticate

▸ **authenticate**(`req`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `req` | `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\> |

#### Returns

`void`

#### Inherited from

PassportStrategy(LoginStrategy, 'login').authenticate

___

### decodeToken

▸ **decodeToken**<`T`\>(`token`, `options?`): `T`

#### Type parameters

| Name |
| :------ |
| `T` |

#### Parameters

| Name | Type |
| :------ | :------ |
| `token` | `string` |
| `options?` | `DecodeOptions` |

#### Returns

`T`

#### Inherited from

PassportStrategy(LoginStrategy, 'login').decodeToken

___

### didUnification

▸ **didUnification**(`did`): `string`

#### Parameters

| Name | Type |
| :------ | :------ |
| `did` | `string` |

#### Returns

`string`

#### Inherited from

PassportStrategy(LoginStrategy, 'login').didUnification

___

### extractSiwe

▸ **extractSiwe**(`req`): `SiweReqPayload`

#### Parameters

| Name | Type |
| :------ | :------ |
| `req` | `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\> |

#### Returns

`SiweReqPayload`

#### Inherited from

PassportStrategy(LoginStrategy, 'login').extractSiwe

___

### extractToken

▸ **extractToken**(`req`): `string`

#### Parameters

| Name | Type |
| :------ | :------ |
| `req` | `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\> |

#### Returns

`string`

#### Inherited from

PassportStrategy(LoginStrategy, 'login').extractToken

___

### getRoleDefinition

▸ **getRoleDefinition**(`namespace`): `Promise`<`IRoleDefinitionV2`\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `namespace` | `string` |

#### Returns

`Promise`<`IRoleDefinitionV2`\>

#### Inherited from

PassportStrategy(LoginStrategy, 'login').getRoleDefinition

___

### isEIP191TokenPayload

▸ **isEIP191TokenPayload**(`payload`): payload is ITokenPayload

#### Parameters

| Name | Type |
| :------ | :------ |
| `payload` | `unknown` |

#### Returns

payload is ITokenPayload

#### Inherited from

PassportStrategy(LoginStrategy, 'login').isEIP191TokenPayload

___

### isSiweMessagePayload

▸ **isSiweMessagePayload**(`payload`): payload is Partial<SiweMessage\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `payload` | `unknown` |

#### Returns

payload is Partial<SiweMessage\>

#### Inherited from

PassportStrategy(LoginStrategy, 'login').isSiweMessagePayload

___

### validate

▸ **validate**(`token`, `payload`, `done`): `Promise`<`void`\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `token` | `string` |
| `payload` | `Partial`<`SiweMessage`\> \| `ITokenPayload` |
| `done` | (`err?`: `Error`, `user?`: `unknown`, `info?`: `unknown`) => `void` |

#### Returns

`Promise`<`void`\>

#### Inherited from

PassportStrategy(LoginStrategy, 'login').validate

___

### verifyIssuer

▸ **verifyIssuer**(`issuer`, `role`): `Promise`<`VerificationResult`\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `issuer` | `string` |
| `role` | `string` |

#### Returns

`Promise`<`VerificationResult`\>

#### Inherited from

PassportStrategy(LoginStrategy, 'login').verifyIssuer
3 changes: 2 additions & 1 deletion docs/api/classes/modules_ipfs_ipfs_service.IPFSService.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

### constructor

• **new IPFSService**(`didStoreCluster`, `didStoreInfura`, `pinsQueue`, `logger`)
• **new IPFSService**(`didStoreCluster`, `didStoreInfura`, `pinsQueue`, `logger`, `configService`)

#### Parameters

Expand All @@ -28,6 +28,7 @@
| `didStoreInfura` | `DidStore` |
| `pinsQueue` | `Queue`<[`PinClaimData`](../modules/modules_ipfs_ipfs_types.md#pinclaimdata)\> |
| `logger` | [`Logger`](modules_logger_logger_service.Logger.md) |
| `configService` | `ConfigService`<`Record`<`string`, `unknown`\>, ``false``\> |

## Methods

Expand Down
6 changes: 4 additions & 2 deletions e2e/ipfs/ipfs.testSuite.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ export const ipfsModuleTestSuite = () => {
await queryRunner.release();
});

it('save() should post claim in cluster', async () => {
// IPFS cluster support is disabled
it.skip('save() should post claim in cluster', async () => {
const claimData = {
claimType: 'claim type',
claimTypeVersion: 1,
Expand Down Expand Up @@ -90,7 +91,8 @@ export const ipfsModuleTestSuite = () => {
.expect(HttpStatus.NOT_FOUND);
});

it('if claim is not found in cluster, get() should save claim in cluster', async () => {
// IPFS cluster support is disabled
it.skip('if claim is not found in cluster, get() should save claim in cluster', async () => {
const didStoreClusterGet = jest.spyOn(didStoreCluster, 'get');
const didStoreInfuraGet = jest.spyOn(didStoreInfura, 'get');

Expand Down
11 changes: 10 additions & 1 deletion src/modules/ipfs/ipfs.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import {
} from './ipfs.types';
import { Logger } from '../logger/logger.service';
import { inspect } from 'util';
import { ConfigService } from '@nestjs/config';

@Injectable()
export class IPFSService {
Expand All @@ -19,7 +20,8 @@ export class IPFSService {
private didStoreInfura: DidStoreGateway,
@InjectQueue(PIN_CLAIM_QUEUE_NAME)
private readonly pinsQueue: Queue<PinClaimData>,
private readonly logger: Logger
private readonly logger: Logger,
private readonly configService: ConfigService
) {
this.logger.setContext(IPFSService.name);
}
Expand Down Expand Up @@ -80,6 +82,13 @@ export class IPFSService {
}
this.logger.debug(`got ${cid}`);

if (!this.configService.get<boolean>('IPFS_CLUSTER_PINNING_ENABLED')) {
this.logger.debug(`IPFS cluster pinning disabled. Skipping for ${cid}`);
return;
}
this.logger.debug(
`IPFS cluster pinning enabled. Pinning IPFS data for ${cid}`
);
try {
await this.pinsQueue.add(PIN_CLAIM_JOB_NAME, { cid, claim });
} catch (e) {
Expand Down
Loading
Loading