Permify /
permify
| Conditions | 52 |
| Total Lines | 398 |
| Code Lines | 241 |
| Lines | 0 |
| Ratio | 0 % |
| Changes | 0 | ||
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
Complex classes like cmd.serve often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
| 1 | package cmd |
||
| 150 | func serve() func(cmd *cobra.Command, args []string) error { |
||
| 151 | return func(cmd *cobra.Command, args []string) error { |
||
| 152 | var cfg *config.Config |
||
| 153 | var err error |
||
| 154 | cfgFile := viper.GetString("config.file") |
||
| 155 | if cfgFile != "" { |
||
| 156 | cfg, err = config.NewConfigWithFile(cfgFile) |
||
| 157 | if err != nil { |
||
| 158 | return fmt.Errorf("failed to create new config: %w", err) |
||
|
introduced
by
|
|||
| 159 | } |
||
| 160 | |||
| 161 | if err = viper.Unmarshal(cfg); err != nil { |
||
| 162 | return fmt.Errorf("failed to unmarshal config: %w", err) |
||
| 163 | } |
||
| 164 | } else { |
||
| 165 | // Load configuration |
||
| 166 | cfg, err = config.NewConfig() |
||
| 167 | if err != nil { |
||
| 168 | return fmt.Errorf("failed to create new config: %w", err) |
||
| 169 | } |
||
| 170 | |||
| 171 | if err = viper.Unmarshal(cfg); err != nil { |
||
| 172 | return fmt.Errorf("failed to unmarshal config: %w", err) |
||
| 173 | } |
||
| 174 | } |
||
| 175 | |||
| 176 | // Print banner and initialize logger |
||
| 177 | internal.PrintBanner() |
||
| 178 | |||
| 179 | var handler slog.Handler |
||
| 180 | |||
| 181 | switch cfg.Log.Output { |
||
| 182 | case "json": |
||
| 183 | handler = telemetry.OtelHandler{ |
||
| 184 | Next: slog.NewJSONHandler(os.Stdout, &slog.HandlerOptions{ |
||
| 185 | Level: getLogLevel(cfg.Log.Level), |
||
| 186 | }), |
||
| 187 | } |
||
| 188 | case "text": |
||
| 189 | handler = telemetry.OtelHandler{ |
||
| 190 | Next: slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{ |
||
| 191 | Level: getLogLevel(cfg.Log.Level), |
||
| 192 | }), |
||
| 193 | } |
||
| 194 | default: |
||
| 195 | handler = telemetry.OtelHandler{ |
||
| 196 | Next: slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{ |
||
| 197 | Level: getLogLevel(cfg.Log.Level), |
||
| 198 | }), |
||
| 199 | } |
||
| 200 | } |
||
| 201 | logger := slog.New(handler) |
||
| 202 | slog.SetDefault(logger) |
||
| 203 | |||
| 204 | internal.Identifier = cfg.AccountID |
||
| 205 | if internal.Identifier == "" { |
||
| 206 | message := "Account ID is not set. Please fill in the Account ID for better support. Get your Account ID from https://permify.co/account" |
||
| 207 | slog.Error(message) |
||
| 208 | |||
| 209 | ticker := time.NewTicker(24 * time.Hour) |
||
| 210 | defer ticker.Stop() |
||
| 211 | |||
| 212 | go func() { |
||
| 213 | for range ticker.C { |
||
| 214 | slog.Error(message) |
||
| 215 | } |
||
| 216 | }() |
||
| 217 | } |
||
| 218 | |||
| 219 | // Set up context and signal handling |
||
| 220 | ctx, stop := signal.NotifyContext(context.Background(), syscall.SIGINT, syscall.SIGTERM) |
||
| 221 | defer stop() |
||
| 222 | |||
| 223 | if cfg.Log.Enabled { |
||
| 224 | headers := map[string]string{} |
||
| 225 | for _, header := range cfg.Log.Headers { |
||
| 226 | h := strings.Split(header, ":") |
||
| 227 | if len(h) != 2 { |
||
| 228 | return errors.New("invalid header format; expected 'key:value'") |
||
| 229 | } |
||
| 230 | headers[h[0]] = h[1] |
||
| 231 | } |
||
| 232 | |||
| 233 | exporter, _ := logexporters.ExporterFactory( |
||
| 234 | cfg.Log.Exporter, |
||
| 235 | cfg.Log.Endpoint, |
||
| 236 | cfg.Log.Insecure, |
||
| 237 | cfg.Log.URLPath, |
||
| 238 | headers, |
||
| 239 | ) |
||
| 240 | lp := telemetry.NewLog(exporter) |
||
| 241 | |||
| 242 | logger := slog.New(otelslog.NewOtelHandler(lp, &otelslog.HandlerOptions{ |
||
| 243 | Level: getLogLevel(cfg.Log.Level), |
||
| 244 | })) |
||
| 245 | |||
| 246 | slog.SetDefault(logger) |
||
| 247 | |||
| 248 | defer func() { |
||
| 249 | if err = lp.Shutdown(ctx); err != nil { |
||
| 250 | slog.Error(err.Error()) |
||
| 251 | } |
||
| 252 | }() |
||
| 253 | } |
||
| 254 | |||
| 255 | slog.Info("🚀 starting permify service...") |
||
| 256 | |||
| 257 | // Run database migration if enabled |
||
| 258 | if cfg.Database.AutoMigrate { |
||
| 259 | err = storage.Migrate(cfg.Database) |
||
| 260 | if err != nil { |
||
| 261 | slog.Error("failed to migrate database", slog.Any("error", err)) |
||
| 262 | } |
||
| 263 | } |
||
| 264 | |||
| 265 | // Initialize database |
||
| 266 | db, err := factories.DatabaseFactory(cfg.Database) |
||
| 267 | if err != nil { |
||
| 268 | slog.Error("failed to initialize database", slog.Any("error", err)) |
||
| 269 | return err |
||
| 270 | } |
||
| 271 | defer func() { |
||
| 272 | if err = db.Close(); err != nil { |
||
| 273 | slog.Error("failed to close database", slog.Any("error", err)) |
||
| 274 | } |
||
| 275 | }() |
||
| 276 | |||
| 277 | // Tracing |
||
| 278 | if cfg.Tracer.Enabled { |
||
| 279 | headers := map[string]string{} |
||
| 280 | for _, header := range cfg.Tracer.Headers { |
||
| 281 | h := strings.Split(header, ":") |
||
| 282 | if len(h) != 2 { |
||
| 283 | return errors.New("invalid header format; expected 'key:value'") |
||
| 284 | } |
||
| 285 | headers[h[0]] = h[1] |
||
| 286 | } |
||
| 287 | |||
| 288 | var exporter trace.SpanExporter |
||
| 289 | exporter, err = tracerexporters.ExporterFactory( |
||
| 290 | cfg.Tracer.Exporter, |
||
| 291 | cfg.Tracer.Endpoint, |
||
| 292 | cfg.Tracer.Insecure, |
||
| 293 | cfg.Tracer.URLPath, |
||
| 294 | headers, |
||
| 295 | ) |
||
| 296 | if err != nil { |
||
| 297 | slog.Error(err.Error()) |
||
| 298 | } |
||
| 299 | |||
| 300 | shutdown := telemetry.NewTracer(exporter) |
||
| 301 | |||
| 302 | defer func() { |
||
| 303 | if err = shutdown(ctx); err != nil { |
||
| 304 | slog.Error(err.Error()) |
||
| 305 | } |
||
| 306 | }() |
||
| 307 | } |
||
| 308 | |||
| 309 | // Garbage collection |
||
| 310 | if cfg.Database.GarbageCollection.Timeout > 0 && cfg.Database.GarbageCollection.Enabled && cfg.Database.Engine != "memory" { |
||
| 311 | slog.Info("🗑️ starting database garbage collection...") |
||
| 312 | |||
| 313 | garbageCollector := gc.NewGC( |
||
| 314 | db.(*PQDatabase.Postgres), |
||
| 315 | gc.Interval(cfg.Database.GarbageCollection.Interval), |
||
| 316 | gc.Window(cfg.Database.GarbageCollection.Window), |
||
| 317 | gc.Timeout(cfg.Database.GarbageCollection.Timeout), |
||
| 318 | ) |
||
| 319 | |||
| 320 | go func() { |
||
| 321 | err = garbageCollector.Start(ctx) |
||
| 322 | if err != nil { |
||
| 323 | slog.Error(err.Error()) |
||
| 324 | } |
||
| 325 | }() |
||
| 326 | } |
||
| 327 | |||
| 328 | // Meter |
||
| 329 | if cfg.Meter.Enabled { |
||
| 330 | headers := map[string]string{} |
||
| 331 | for _, header := range cfg.Meter.Headers { |
||
| 332 | h := strings.Split(header, ":") |
||
| 333 | if len(h) != 2 { |
||
| 334 | return errors.New("invalid header format; expected 'key:value'") |
||
| 335 | } |
||
| 336 | headers[h[0]] = h[1] |
||
| 337 | } |
||
| 338 | |||
| 339 | var exporter metric.Exporter |
||
| 340 | exporter, err = meterexporters.ExporterFactory( |
||
| 341 | cfg.Meter.Exporter, |
||
| 342 | cfg.Meter.Endpoint, |
||
| 343 | cfg.Meter.Insecure, |
||
| 344 | cfg.Meter.URLPath, |
||
| 345 | headers, |
||
| 346 | ) |
||
| 347 | |||
| 348 | if err != nil { |
||
| 349 | slog.Error(err.Error()) |
||
| 350 | } |
||
| 351 | |||
| 352 | shutdown := telemetry.NewMeter(exporter, time.Duration(cfg.Meter.Interval)*time.Second) |
||
| 353 | |||
| 354 | defer func() { |
||
| 355 | if err = shutdown(ctx); err != nil { |
||
| 356 | slog.Error(err.Error()) |
||
| 357 | } |
||
| 358 | }() |
||
| 359 | } |
||
| 360 | |||
| 361 | // schema cache |
||
| 362 | var schemaCache pkgcache.Cache |
||
| 363 | schemaCache, err = ristretto.New(ristretto.NumberOfCounters(cfg.Service.Schema.Cache.NumberOfCounters), ristretto.MaxCost(cfg.Service.Schema.Cache.MaxCost)) |
||
| 364 | if err != nil { |
||
| 365 | slog.Error(err.Error()) |
||
| 366 | return err |
||
| 367 | } |
||
| 368 | |||
| 369 | // engines cache cache |
||
| 370 | var engineKeyCache pkgcache.Cache |
||
| 371 | engineKeyCache, err = ristretto.New(ristretto.NumberOfCounters(cfg.Service.Permission.Cache.NumberOfCounters), ristretto.MaxCost(cfg.Service.Permission.Cache.MaxCost)) |
||
| 372 | if err != nil { |
||
| 373 | slog.Error(err.Error()) |
||
| 374 | return err |
||
| 375 | } |
||
| 376 | |||
| 377 | watcher := storage.NewNoopWatcher() |
||
| 378 | if cfg.Service.Watch.Enabled { |
||
| 379 | watcher = factories.WatcherFactory(db) |
||
| 380 | } |
||
| 381 | |||
| 382 | // Initialize the storage with factory methods |
||
| 383 | dataReader := factories.DataReaderFactory(db) |
||
| 384 | dataWriter := factories.DataWriterFactory(db) |
||
| 385 | bundleReader := factories.BundleReaderFactory(db) |
||
| 386 | bundleWriter := factories.BundleWriterFactory(db) |
||
| 387 | schemaReader := factories.SchemaReaderFactory(db) |
||
| 388 | schemaWriter := factories.SchemaWriterFactory(db) |
||
| 389 | tenantReader := factories.TenantReaderFactory(db) |
||
| 390 | tenantWriter := factories.TenantWriterFactory(db) |
||
| 391 | |||
| 392 | // Add caching to the schema reader using a decorator |
||
| 393 | schemaReader = cacheDecorator.NewSchemaReader(schemaReader, schemaCache) |
||
| 394 | |||
| 395 | dataReader = sfDecorator.NewDataReader(dataReader) |
||
| 396 | schemaReader = sfDecorator.NewSchemaReader(schemaReader) |
||
| 397 | |||
| 398 | // Check if circuit breaker should be enabled for services |
||
| 399 | if cfg.Service.CircuitBreaker { |
||
| 400 | var cb *gobreaker.CircuitBreaker |
||
| 401 | var st gobreaker.Settings |
||
| 402 | st.Name = "storage" |
||
| 403 | st.ReadyToTrip = func(counts gobreaker.Counts) bool { |
||
| 404 | failureRatio := float64(counts.TotalFailures) / float64(counts.Requests) |
||
| 405 | return counts.Requests >= 10 && failureRatio >= 0.6 |
||
| 406 | } |
||
| 407 | |||
| 408 | cb = gobreaker.NewCircuitBreaker(st) |
||
| 409 | |||
| 410 | // Add circuit breaker to the relationship reader using decorator |
||
| 411 | dataReader = cbDecorator.NewDataReader(dataReader, cb) |
||
| 412 | |||
| 413 | // Add circuit breaker to the bundle reader using decorators |
||
| 414 | bundleReader = cbDecorator.NewBundleReader(bundleReader, cb) |
||
| 415 | |||
| 416 | // Add circuit breaker to the schema reader using decorator |
||
| 417 | schemaReader = cbDecorator.NewSchemaReader(schemaReader, cb) |
||
| 418 | |||
| 419 | // Add circuit breaker to the tenant reader using decorator |
||
| 420 | tenantReader = cbDecorator.NewTenantReader(tenantReader, cb) |
||
| 421 | } |
||
| 422 | |||
| 423 | // Initialize the engines using the key manager, schema reader, and relationship reader |
||
| 424 | checkEngine := engines.NewCheckEngine(schemaReader, dataReader, engines.CheckConcurrencyLimit(cfg.Service.Permission.ConcurrencyLimit)) |
||
| 425 | expandEngine := engines.NewExpandEngine(schemaReader, dataReader) |
||
| 426 | |||
| 427 | // Declare a variable `checker` of type `invoke.Check`. |
||
| 428 | var checker invoke.Check |
||
| 429 | |||
| 430 | // Create the checker either with load balancing or caching capabilities. |
||
| 431 | if cfg.Distributed.Enabled { |
||
| 432 | |||
| 433 | if cfg.Authn.Enabled && cfg.Authn.Method == "oidc" { |
||
| 434 | return errors.New("OIDC authentication method cannot be used in distributed mode. Please check your configuration") |
||
| 435 | } |
||
| 436 | |||
| 437 | checker, err = balancer.NewCheckEngineWithBalancer( |
||
| 438 | ctx, |
||
| 439 | checkEngine, |
||
| 440 | schemaReader, |
||
| 441 | &cfg.Distributed, |
||
| 442 | &cfg.Server.GRPC, |
||
| 443 | &cfg.Authn, |
||
| 444 | ) |
||
| 445 | // Handle potential error during checker creation. |
||
| 446 | if err != nil { |
||
| 447 | return err |
||
| 448 | } |
||
| 449 | checker = cache.NewCheckEngineWithCache( |
||
| 450 | checker, |
||
| 451 | schemaReader, |
||
| 452 | engineKeyCache, |
||
| 453 | ) |
||
| 454 | } else { |
||
| 455 | checker = cache.NewCheckEngineWithCache( |
||
| 456 | checkEngine, |
||
| 457 | schemaReader, |
||
| 458 | engineKeyCache, |
||
| 459 | ) |
||
| 460 | } |
||
| 461 | |||
| 462 | // Create a localChecker which directly checks without considering distributed setup. |
||
| 463 | // This also includes caching capabilities. |
||
| 464 | localChecker := cache.NewCheckEngineWithCache( |
||
| 465 | checkEngine, |
||
| 466 | schemaReader, |
||
| 467 | engineKeyCache, |
||
| 468 | ) |
||
| 469 | |||
| 470 | // Initialize the lookupEngine, which is responsible for looking up certain entities or values. |
||
| 471 | lookupEngine := engines.NewLookupEngine( |
||
| 472 | checker, |
||
| 473 | schemaReader, |
||
| 474 | dataReader, |
||
| 475 | // Set concurrency limit based on the configuration. |
||
| 476 | engines.LookupConcurrencyLimit(cfg.Service.Permission.BulkLimit), |
||
| 477 | ) |
||
| 478 | |||
| 479 | // Initialize the subjectPermissionEngine, responsible for handling subject permissions. |
||
| 480 | subjectPermissionEngine := engines.NewSubjectPermission( |
||
| 481 | checker, |
||
| 482 | schemaReader, |
||
| 483 | // Set concurrency limit for the subject permission checks. |
||
| 484 | engines.SubjectPermissionConcurrencyLimit(cfg.Service.Permission.ConcurrencyLimit), |
||
| 485 | ) |
||
| 486 | |||
| 487 | // Create a new invoker that is used to directly call various functions or engines. |
||
| 488 | // It encompasses the schema, data, checker, and other engines. |
||
| 489 | invoker := invoke.NewDirectInvoker( |
||
| 490 | schemaReader, |
||
| 491 | dataReader, |
||
| 492 | checker, |
||
| 493 | expandEngine, |
||
| 494 | lookupEngine, |
||
| 495 | subjectPermissionEngine, |
||
| 496 | ) |
||
| 497 | |||
| 498 | // Associate the invoker with the checkEngine. |
||
| 499 | checkEngine.SetInvoker(invoker) |
||
| 500 | |||
| 501 | // Create a local invoker for local operations. |
||
| 502 | localInvoker := invoke.NewDirectInvoker( |
||
| 503 | schemaReader, |
||
| 504 | dataReader, |
||
| 505 | localChecker, |
||
| 506 | expandEngine, |
||
| 507 | lookupEngine, |
||
| 508 | subjectPermissionEngine, |
||
| 509 | ) |
||
| 510 | |||
| 511 | // Initialize the container which brings together multiple components such as the invoker, data readers/writers, and schema handlers. |
||
| 512 | container := servers.NewContainer( |
||
| 513 | invoker, |
||
| 514 | dataReader, |
||
| 515 | dataWriter, |
||
| 516 | bundleReader, |
||
| 517 | bundleWriter, |
||
| 518 | schemaReader, |
||
| 519 | schemaWriter, |
||
| 520 | tenantReader, |
||
| 521 | tenantWriter, |
||
| 522 | watcher, |
||
| 523 | ) |
||
| 524 | |||
| 525 | // Create an error group with the provided context |
||
| 526 | var g *errgroup.Group |
||
| 527 | g, ctx = errgroup.WithContext(ctx) |
||
| 528 | |||
| 529 | // Add the container.Run function to the error group |
||
| 530 | g.Go(func() error { |
||
| 531 | return container.Run( |
||
| 532 | ctx, |
||
| 533 | &cfg.Server, |
||
| 534 | logger, |
||
| 535 | &cfg.Distributed, |
||
| 536 | &cfg.Authn, |
||
| 537 | &cfg.Profiler, |
||
| 538 | localInvoker, |
||
| 539 | ) |
||
| 540 | }) |
||
| 541 | |||
| 542 | // Wait for the error group to finish and log any errors |
||
| 543 | if err = g.Wait(); err != nil { |
||
| 544 | slog.Error(err.Error()) |
||
| 545 | } |
||
| 546 | |||
| 547 | return nil |
||
| 548 | } |
||
| 566 |
Loading history...